<!DOCTYPE HTML>

<html lang="en">
<head>

<title>MvcRequestMatcher (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="MvcRequestMatcher (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":42,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="MvcRequestMatcher.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="MvcRequestMatcher.html#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="MvcRequestMatcher.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="MvcRequestMatcher.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="MvcRequestMatcher.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="MvcRequestMatcher.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.web.servlet.util.matcher</a></div>
<h2 title="Class MvcRequestMatcher" class="title">Class MvcRequestMatcher</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.security.web.servlet.util.matcher.MvcRequestMatcher</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher">RequestMatcher</a></code>, <code><a href="../../../util/matcher/RequestVariablesExtractor.html" title="interface in org.springframework.security.web.util.matcher">RequestVariablesExtractor</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">MvcRequestMatcher</span>
extends java.lang.Object
implements <a href="../../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher">RequestMatcher</a>, <a href="../../../util/matcher/RequestVariablesExtractor.html" title="interface in org.springframework.security.web.util.matcher">RequestVariablesExtractor</a></pre>
<div class="block">A <a href="../../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher"><code>RequestMatcher</code></a> that uses Spring MVC's <code>HandlerMappingIntrospector</code> to
match the path and extract variables.
<p>
It is important to understand that Spring MVC's matching is relative to the servlet
path. This means if you have mapped any servlet to a path that starts with "/" and is
greater than one, you should also specify the <a href="MvcRequestMatcher.html#setServletPath(java.lang.String)"><code>setServletPath(String)</code></a> attribute
to differentiate mappings.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.1.1</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">

</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.springframework.security.web.util.matcher.RequestMatcher">

</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.springframework.security.web.util.matcher.<a href="../../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher">RequestMatcher</a></h3>
<code><a href="../../../util/matcher/RequestMatcher.MatchResult.html" title="class in org.springframework.security.web.util.matcher">RequestMatcher.MatchResult</a></code></li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="MvcRequestMatcher.html#%3Cinit%3E(org.springframework.web.servlet.handler.HandlerMappingIntrospector,java.lang.String)">MvcRequestMatcher</a></span>&#8203;(org.springframework.web.servlet.handler.HandlerMappingIntrospector&nbsp;introspector,
java.lang.String&nbsp;pattern)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MvcRequestMatcher.html#extractUriTemplateVariables(javax.servlet.http.HttpServletRequest)">extractUriTemplateVariables</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MvcRequestMatcher.html#getServletPath()">getServletPath</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../util/matcher/RequestMatcher.MatchResult.html" title="class in org.springframework.security.web.util.matcher">RequestMatcher.MatchResult</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MvcRequestMatcher.html#matcher(javax.servlet.http.HttpServletRequest)">matcher</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</code></th>
<td class="colLast">
<div class="block">Returns a MatchResult for this RequestMatcher The default implementation returns
<code>Collections.emptyMap()</code> when <a href="../../../util/matcher/RequestMatcher.MatchResult.html#getVariables()"><code>RequestMatcher.MatchResult.getVariables()</code></a> is invoked.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MvcRequestMatcher.html#matches(javax.servlet.http.HttpServletRequest)">matches</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</code></th>
<td class="colLast">
<div class="block">Decides whether the rule implemented by the strategy matches the supplied request.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MvcRequestMatcher.html#setMethod(org.springframework.http.HttpMethod)">setMethod</a></span>&#8203;(org.springframework.http.HttpMethod&nbsp;method)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MvcRequestMatcher.html#setServletPath(java.lang.String)">setServletPath</a></span>&#8203;(java.lang.String&nbsp;servletPath)</code></th>
<td class="colLast">
<div class="block">The servlet path to match on.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MvcRequestMatcher.html#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.springframework.web.servlet.handler.HandlerMappingIntrospector,java.lang.String)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MvcRequestMatcher</h4>
<pre>public&nbsp;MvcRequestMatcher&#8203;(org.springframework.web.servlet.handler.HandlerMappingIntrospector&nbsp;introspector,
                         java.lang.String&nbsp;pattern)</pre>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="matches(javax.servlet.http.HttpServletRequest)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>matches</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;matches&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../util/matcher/RequestMatcher.html#matches(javax.servlet.http.HttpServletRequest)">RequestMatcher</a></code></span></div>
<div class="block">Decides whether the rule implemented by the strategy matches the supplied request.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/matcher/RequestMatcher.html#matches(javax.servlet.http.HttpServletRequest)">matches</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher">RequestMatcher</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the request to check for a match</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the request matches, false otherwise</dd>
</dl>
</li>
</ul>
<a id="extractUriTemplateVariables(javax.servlet.http.HttpServletRequest)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>extractUriTemplateVariables</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;extractUriTemplateVariables&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../util/matcher/RequestVariablesExtractor.html#extractUriTemplateVariables(javax.servlet.http.HttpServletRequest)">RequestVariablesExtractor</a></code></span></div>
<div class="block">Extract URL template variables from the request.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/matcher/RequestVariablesExtractor.html#extractUriTemplateVariables(javax.servlet.http.HttpServletRequest)">extractUriTemplateVariables</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/matcher/RequestVariablesExtractor.html" title="interface in org.springframework.security.web.util.matcher">RequestVariablesExtractor</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the HttpServletRequest to obtain a URL to extract the variables from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URL variables or empty if no variables are found</dd>
</dl>
</li>
</ul>
<a id="matcher(javax.servlet.http.HttpServletRequest)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>matcher</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../util/matcher/RequestMatcher.MatchResult.html" title="class in org.springframework.security.web.util.matcher">RequestMatcher.MatchResult</a>&nbsp;matcher&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../util/matcher/RequestMatcher.html#matcher(javax.servlet.http.HttpServletRequest)">RequestMatcher</a></code></span></div>
<div class="block">Returns a MatchResult for this RequestMatcher The default implementation returns
<code>Collections.emptyMap()</code> when <a href="../../../util/matcher/RequestMatcher.MatchResult.html#getVariables()"><code>RequestMatcher.MatchResult.getVariables()</code></a> is invoked.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/matcher/RequestMatcher.html#matcher(javax.servlet.http.HttpServletRequest)">matcher</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/matcher/RequestMatcher.html" title="interface in org.springframework.security.web.util.matcher">RequestMatcher</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the MatchResult from comparing this RequestMatcher against the
HttpServletRequest</dd>
</dl>
</li>
</ul>
<a id="setMethod(org.springframework.http.HttpMethod)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setMethod</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMethod&#8203;(org.springframework.http.HttpMethod&nbsp;method)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>method</code> - the method to set</dd>
</dl>
</li>
</ul>
<a id="setServletPath(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setServletPath</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setServletPath&#8203;(java.lang.String&nbsp;servletPath)</pre>
<div class="block">The servlet path to match on. The default is undefined which means any servlet
path.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>servletPath</code> - the servletPath to set</dd>
</dl>
</li>
</ul>
<a id="getServletPath()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletPath</h4>
<pre class="methodSignature">protected final&nbsp;java.lang.String&nbsp;getServletPath()</pre>
</li>
</ul>
<a id="toString()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="MvcRequestMatcher.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="MvcRequestMatcher.html#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="MvcRequestMatcher.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="MvcRequestMatcher.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="MvcRequestMatcher.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="MvcRequestMatcher.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040e41c488c97cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
